Skip to content

Retrieve domain-based restriction details

Request

Returns data about domain-based restriction for Hub access restriction methods providing authentication of user with user email.
Applies to:

  • SAML - optional,
  • Google OAuth - required.

Once set if visitor trying to sign-in has a domain reported by authentication method not matching any of the domains in domains whitelist, the access to Hub is not granted even if authentication method normally would grant access to this visitor.

Required to be enabled when using Google OAuth restriction method.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/access_restriction/domains_whitelist?api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
enabledboolean
domains_whitelistArray of strings

Array of domain names.

Example:
[
  "company.com",
  "another-domain.com"
]
Response
{
  "enabled": true,
  "domains_whitelist": [
    "company.com",
    "another-domain.com"
  ]
}